﻿#region LGPL License

/*
OpenSearchNet
Copyright (c) 2014, Brad Hards <bradh@frogmouth.net>, All rights reserved.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library.
*/

#endregion LGPL License

namespace OpenSearch
{
    /// <summary>
    /// Kind of parameter used in OpenSearch query template
    /// </summary>
    public enum TemplateParameterKind
    {
        /// <summary>
        /// Parameter must be substituted
        /// </summary>
        RequiredSubstitution,

        /// <summary>
        /// Parameter may or may not be substituted
        /// </summary>
        OptionalSubstitution,

        /// <summary>
        /// Parameter is not subject to subtitution, but should be used literally
        /// </summary>
        Literal
    }
}